sfdc-ux (CWP)

(0 reviews)

TMF641 -getServiceOrder

/{businessId}/serviceOrder

[GET]

This method is to retrieve serviceOrder information.

https://nonprod.cwp.esb.cloud.lla.com/dev/sfdc-ux-cwp/sfdc-ux/v1/{businessId}/serviceOrder
url Param
nametypedescriptionrequired
businessIdstring2 letter ISO 3166 country code (TT, BS, JM) identifying the business unit.Y
nametypedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API requestN
Query Param
nametypedescriptionrequired
orderDate.gtestringorder date time [greater or equal than]Y
orderDate.ltestringorder date time [lower or equal than]Y
realtedParty.idstringRelated Party reference. A related party defines party or party role linked to a specific entity. id is unique identifier of the PartyY
serviceOrderItem.service.idstringunique identifier of the serviceY
Sample Response
[
    {
        "id": "PL55632",
        "completionDate": "28-Dec-2006 12:55:08",
        "externalId": "390124338271813641",
        "relatedParty": [
            {
                "id": "145042410000",
                "name": "BillingAccount",
                "role": "PCCS"
            }
        ],
        "serviceOrderItem": [
            {
                "service": {
                    "id": "8766804769",
                    "state": "PTC"
                }
            }
        ],
        "state": "C-Complete"
    },
    {
        "id": "",
        "completionDate": "07-Sep-2006 16:40:05",
        "externalId": "390124333576749064",
        "relatedParty": [
            {
                "id": "145042410000",
                "name": "BillingAccount",
                "role": ""
            }
        ],
        "serviceOrderItem": [
            {
                "service": {
                    "id": "8766804769",
                    "state": "ROSB"
                }
            }
        ],
        "state": "C-Complete"
    },
    {
        "id": "",
        "completionDate": "07-Sep-2006 16:11:30",
        "externalId": "390124333576552451",
        "relatedParty": [
            {
                "id": "145042410000",
                "name": "BillingAccount",
                "role": ""
            }
        ],
        "serviceOrderItem": [
            {
                "service": {
                    "id": "8766804769",
                    "state": "BAR"
                }
            }
        ],
        "state": "C-Complete"
    },
    {
        "id": "",
        "completionDate": "07-Mar-2006 10:01:25",
        "externalId": "390124327775371271",
        "relatedParty": [
            {
                "id": "145042410000",
                "name": "BillingAccount",
                "role": ""
            }
        ],
        "serviceOrderItem": [
            {
                "service": {
                    "id": "8766804769",
                    "state": "MIGRAT"
                }
            }
        ],
        "state": "F-ERR=Unable"
    }
]

Reviews